GET Live Videos Paged List

Overview

---

The table below provides key details about the GET method for retrieving a paged list of Live Videos.

GET Live Videos Paged List
Method	GET
URL or Endpoint	/api/v1/projectId/live-videos
Headers	Authorization
Parameters	projectId, search(query), order(query), insertedDate(query), page(query), take(query)
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
search	No	string	Search for a specific live video
order	No	string	Specified the order position of the live video
insertedDate	No	string($date-time)	Date time
page	No	integer($int32)	Current page you want to receive
take	No	integer($int32)	Number of live videos you want to receive
projectId	Yes	string	The id of the project.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "currentPage": 1,
    "totalPages": 2,
    "pageSize": 10,
    "totalCount": 17,
    "items": [
      {
        "publicId": "{videoId}",
        "title": "{title}",
        "author": "{author}",
        "publishDate": "2024-05-22T14:33:57.7878526",
        "liveStatus": "Live",
        "canGoLive": false,
        "canCutAndPublish": true,
        "isLiveStreaming": true,
        "canStopAndCut": true,
        "thumbnail": "https://cdn.vpplayer.tech/{projectId}/images/{images}/live-thumbnail.jpg"
        
      },
      {
        "publicId": "{videoId}",
        "title": "{title}",
        "author": "{author}",
        "publishDate": "2024-05-23T10:32:24.9257227",
        "liveStatus": "Offline",
        "canGoLive": false,
        "canCutAndPublish": true,
        "isLiveStreaming": false,
        "canStopAndCut": false,
        "thumbnail": "https://cdn.vpplayer.tech/{projectId}/images/{images}/live-thumbnail.jpg"
        
      },
      
    ]
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
currentPage	integer($int32)	Returns the current page number in the paginated list of live videos.
totalPages	integer($int32)	Returns the total number of pages available for the live videos list
pageSize	integer($int32)	Specifies the maximum number of live videos that can be displayed on a single page
totalCount	integer($int32)	Returns the total number of live videos that are in that page
items	array[Object]	Returns the list of live video objects with detailed information for each live video.
publicId	string	Returns the public identifier for the live video
title	string	Returns the title of the live video
author	string	Returns the author of the live video
publishDate	string($date-time)	The date and time when the video was published
liveStatus	string	Current live status of the live video
canGoLive	bool	Indicates whether the video can be set to live
canCutandPublish	bool	Indicates whether the video can be edited and published
isLiveStreaming	bool	Indicates whether the video is currently being live streamed
canStopandCut	bool	Indicates whether the video can be cut and stopped
thumbnail	string	The URL of the thumbnail image for the live video
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed